home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / uudo11.zip / UUDO11.DOC < prev   
Text File  |  1993-01-20  |  6KB  |  125 lines

  1. UUDO v1.1  (c) 1993, Ryan Kim.  -  Multi-file/Multi-part uudecoder
  2.  
  3.  
  4. DESCRIPTION:
  5.  
  6. - UUDO is an uudecoder for DOS for generating binary files from
  7.   uuencoded files that may be split into many parts.
  8. - The only requirement is that, for multi-part files, each uuencoded part must
  9.   be in its own file and has a "Subject: ..." line indicating the part number.
  10.   (Assuming the uuencoded files are coming from the Usenet:
  11.   This can be done easily by issuing "s" command without filename inside rn.
  12.   Make sure to start rn with -N and -/ options.)
  13. - UUDO supports the subject line with part numbers in the format of "##/##" or
  14.   "## of ##", where ## is the part number, and the second ## is
  15.   the total part number.
  16.   If none of these is found, it is assumed that the file contains the entire
  17.   uuencoded text for a binary.
  18. - If any error is found in generating a binary file, UUDO will copy all the
  19.   uuencoded part files for that binary to the error directory which must be
  20.   specified in the command line.
  21. - A report is generated describing which uuencoded texts were decoded into
  22.   which binary files.
  23.  
  24.  
  25. DISCLAIMER:
  26.  
  27. - This is a FREEWARE.  Although the program is copyrighted by me, Ryan Kim,
  28.   you're allowed to use, copy, and distribute this program for FREE
  29.   as long as nothing is modified in any way, this document is
  30.   always present with the program, and you're not gaining any profit
  31.   with this program.
  32. - There is no warranty whatsoever.  Use it at your own risk!
  33.  
  34. - Please read the section marked "FINAL NOTES" at the end of this document
  35.   for a small (non-obligatory) favour I ask for the users of UUDO program.
  36.  
  37.  
  38. HOW TO:
  39.  
  40. Typing UUDO by itself gives the following help screen:
  41.  
  42. UUDO v1.1  (c) 1993, Ryan Kim.  -  Multi-file/Multi-part uudecoder
  43.  
  44. Usage:  UUDO [/n] [/k] [/r1] [/r2] input_files error_directory
  45.              where /n:   No report file "UUDO.REP" generated
  46.                    /k:   Keep incomplete binary files
  47.                    /r1:  Relaxed format-checking level 1
  48.                    /r2:  Relaxed format-checking level 2 (See Doc)
  49.  
  50. 1. If you're getting the uuencoded files from the Usenet:
  51.    In 'rn', save each article in different files by doing, say, "1650-1759 s".
  52.    This will save different articles in files 1650, 1651, 1652, ..., 1759,
  53.    provided that you turned on -N and -/ switches in 'rn' command line.
  54. 2. Move these files to a DOS machine.  This may be either in text or
  55.    binary mode file transfer.
  56. 3. Assuming you have a path to UUDO.EXE, or UUDO is available somewhere,
  57.    and all the above files are in the current directory:
  58.    Create a subdirectory called ERROR, from the current directory.
  59. 4. Type "UUDO *.* error"
  60.  
  61. Now, UUDO will extract all the binary files to the current directory.
  62. Any files that cannot be decoded properly will be copied to
  63. the "error" directory, you just created.
  64. UUDO will also create a file called "UUDO.REP" in the current directory
  65. and report which files are decoded to which.  This is very handy way of
  66. checking where the binaries came from and how UUDO read the subject line.
  67.  
  68. UUDO has a few options to accomodate some uuencoded files that may contain
  69. errors or may not use the standard uuencode format:
  70.  
  71. /k option:   By default, UUDO deletes any binary files that were not decoded
  72.              properly to the end.  If this option is specified, UUDO will keep
  73.              all the binary files with error, even though they're incomplete.
  74. /r1 option:  With this option, UUDO will not do most of the uuencode format
  75.              checking.  This is useful when the uuencoded file uses some
  76.              non-standard uuencode format and UUDO stops at certain line.
  77.              NOTE:  /r1 and /r2 options may generate incorrect binary file
  78.                     because many format checkings are not done.  Use these
  79.                     options only on files that UUDO has trouble decoding.
  80. /r2 option:  This option may be used when /r1 option generates the correct
  81.              binary file except the last few bytes.  Use this after you tried
  82.              /r1 option.  You may have to put all the parts together manually.
  83. If all these do not work, the uuencoded file probably contains
  84. some unrecoverable errors.  If you are _really_ desperate, you may try
  85. to concatenate all uuencoded parts together in a file (deleting all
  86. non-uuencoded texts) and use /r2 option, although, it may still not work.
  87.  
  88. UUDO uses two file names (which may be different) to indicate the name of
  89. the binary file.  The first is the name UUDO found in the subject line
  90. and the second is the name UUDO found in "begin xxx zzzz" line of
  91. the uuencoded text.  UUDO will use the first name until the real name
  92. (the second name) is found.
  93.  
  94. You can press ESC key at any time to stop UUDO.  There will be slight delay
  95. while UUDO finishes off its current operation.
  96.  
  97.  
  98. HISTORY:
  99.  
  100. v1.0     Initial Release to a few testers for some first-impressions.
  101. v1.1     The first general public release of UUDO!
  102.          Minor changes in command-line options and the document.
  103.  
  104.  
  105. FINAL NOTES:
  106.  
  107. I wrote this program for my personal use (to save my precious time from
  108. looking through files, trying to fit pieces together, and decoding),
  109. and I hope you will find it useful also.
  110.  
  111. I'd like very much to know if you're using this program since this is,
  112. I believe, my first program that could be used widely around the world.
  113. I would appreciate it very much if you could drop me a line and tell me
  114. where you're from, and where you got this program (i.e. Usenet group name,
  115. FTP site name, BBS name, etc).  This is for some statistics for my personal
  116. use.  Don't worry, I won't sell your names to the junk-mail companies
  117. and NO SALESPERSON WILL CALL YOU.    :-)
  118. Thanks!
  119.  
  120. I can be reached by e-mail at rkim@eecg.toronto.edu
  121.  
  122.  
  123.                                                        Ryan
  124.                                           from Scarborough, Ontario, CANADA
  125.